home *** CD-ROM | disk | FTP | other *** search
/ Aminet 25 / Aminet 25 (1998)(GTI - Schatztruhe)[!][Jun 1998].iso / Aminet / comm / tcp / rxsocket.lha / function.ref < prev    next >
Encoding:
Text File  |  1998-04-08  |  9.5 KB  |  467 lines

  1.  
  2. 1.Short Function reference guide
  3. 2.Human forms
  4. 3.Fields names
  5.  
  6. ------------------------------------------------------------------------------------
  7.  
  8.  
  9. 1.Short Function reference guide
  10.  
  11. ------------------------------------------------------------------------------------
  12.  
  13. ACCEPT
  14. LV
  15. <socket/N>,<stem/V>
  16. Accept e connection
  17.  
  18. ------------------------------------------------------------------------------------
  19.  
  20. ADDR2C
  21. L
  22. <addr/N>
  23. Converts from Internet address to packed char
  24.  
  25. ------------------------------------------------------------------------------------
  26.  
  27. BIND
  28. LV
  29. <socket/N>,<stem/V>
  30. Bind a socket on a port
  31.  
  32. ------------------------------------------------------------------------------------
  33.  
  34. CLOSESOCKET
  35. L
  36. <socket/N>
  37. Close a socket
  38.  
  39. ------------------------------------------------------------------------------------
  40.  
  41. CONNECT
  42. LV
  43. <socket/N>,<stem/V>
  44. Connect a socket
  45.  
  46. ------------------------------------------------------------------------------------
  47.  
  48. DUP2SOCKET
  49. L
  50. <socket/N>
  51. Dup a socket
  52.  
  53. ------------------------------------------------------------------------------------
  54.  
  55. ERRNO
  56. -
  57. -
  58. Return current error number
  59.  
  60. ------------------------------------------------------------------------------------
  61.  
  62. ERRORSTRING
  63. L
  64. <code/N>
  65. Return string associated with error code
  66.  
  67. ------------------------------------------------------------------------------------
  68.  
  69. GETHOSTBYADDR
  70. VL
  71. <stem/V>,<addr/N>
  72.  
  73. ------------------------------------------------------------------------------------
  74.  
  75. GETHOSTBYNAME
  76. VD
  77. <stem/V>,<hostName>
  78.  
  79. Make a lookup an a host name
  80.  
  81. ------------------------------------------------------------------------------------
  82.  
  83. GETHOSTID
  84. -
  85. -
  86. Return current host id
  87.  
  88. ------------------------------------------------------------------------------------
  89.  
  90. GETHOSTNAME
  91. V
  92. <stem/V>
  93. Return in stem current host name
  94.  
  95. ------------------------------------------------------------------------------------
  96.  
  97. GETPEERNAME,
  98. LV
  99. <socket/N>,<stem/V>
  100.  
  101. Fill stem with info about (connected) socket
  102.  
  103. ------------------------------------------------------------------------------------
  104.  
  105. GETPROTOBYNAME
  106. VD
  107. <stem/V>,<protocol>
  108. Search for local protocol entry by name
  109.  
  110. ------------------------------------------------------------------------------------
  111.  
  112. GETPROTOBYNUMBUER
  113. VL
  114. <stem/V>,<protocol/N>
  115. Search for local protocol entry by number
  116.  
  117. ------------------------------------------------------------------------------------
  118.  
  119. GETSERVBYNAME
  120. VDD
  121. <stem/V>,<name>,<proto>
  122. Search for local serv entry by service name
  123.  
  124. ------------------------------------------------------------------------------------
  125.  
  126. GETSERVBYPORT
  127. VLD
  128. <stem/V>,<port/N>,<proto>
  129. Serach for local serv entry by port number
  130.  
  131. ------------------------------------------------------------------------------------
  132.  
  133. GETSOCKETBASE
  134. V
  135. <stem/V>
  136. Get various things from bsdsocket.library base
  137.  
  138. ------------------------------------------------------------------------------------
  139.  
  140. GETSOCKETEVENTS
  141. V
  142. <stem/V>
  143. Return last events happened on sockets
  144.  
  145. ------------------------------------------------------------------------------------
  146.  
  147. GETSOCKNAME
  148. LV
  149. <socket/N>,<stem/V>
  150. Get socket
  151.  
  152. ------------------------------------------------------------------------------------
  153.  
  154. GETSOCKOPT
  155. LSSV
  156. <socket/N>,<level>,<name>,<stem/V>
  157. Get various things from socket at level level
  158.  
  159. ------------------------------------------------------------------------------------
  160.  
  161. HELP
  162. S
  163. <funName>
  164. Return string info of a function
  165.  
  166. ------------------------------------------------------------------------------------
  167.  
  168. ISLIBON
  169. D
  170. <name>
  171. Tests the stack running or the presence of a library
  172.  
  173. ------------------------------------------------------------------------------------
  174.  
  175. HOSTERRORNO
  176. -
  177. -
  178. Return current host lookup error
  179.  
  180. ------------------------------------------------------------------------------------
  181.  
  182. HOSTERRORSTRING
  183. L
  184. <code/N>
  185. Return string associated with host lookup code error
  186.  
  187. ------------------------------------------------------------------------------------
  188.  
  189. INETADDR
  190. D
  191. <addr>
  192. Convert an Internet address from string form to long
  193.  
  194. ------------------------------------------------------------------------------------
  195.  
  196. INETCKSUM
  197. DL
  198. <data>,<len>
  199. Compute an Internet checksum
  200.  
  201. ------------------------------------------------------------------------------------
  202.  
  203. INETNTOA
  204. L
  205. <addr/N>
  206. Convert an Internet address from long to string
  207.  
  208. ------------------------------------------------------------------------------------
  209.  
  210. IOCTLSOCKET
  211. LVD
  212. <socket/N>,<req>,<value/N>
  213. Set option on socket
  214.  
  215. ------------------------------------------------------------------------------------
  216.  
  217. LISTEN
  218. LL
  219. <socket/N>,<backlog/n>
  220. Listen a socket
  221.  
  222. ------------------------------------------------------------------------------------
  223.  
  224. OBTAINSOCKET
  225. LDDD
  226. <key/N>,<family>,<type>,<protocol>
  227. Obtain a released socket
  228.  
  229. ------------------------------------------------------------------------------------
  230.  
  231. OPENCONNECTION
  232. DDddv
  233. <proto>,<localport>,[host],[remoteport],[stem/V]
  234. Create a socket and ...
  235.  
  236. ------------------------------------------------------------------------------------
  237.  
  238. RECV
  239. LVLd
  240. <socket/N>,<stem/V>,<len/N>,[flags/N]
  241. Receive data from a connected socket
  242.  
  243. ------------------------------------------------------------------------------------
  244.  
  245. RECVFROM
  246. LVLdv
  247. <socket/N>,<stem/V>,<len/n>,[flags/N],[stem/V]
  248. Receive data from a socket
  249.  
  250. ------------------------------------------------------------------------------------
  251.  
  252. RECVLINE
  253. LVLdv
  254. <socket/N>,<stem/V>,<len/n>,[flags/N],[stem/V]
  255. Receive a line from a socket
  256.  
  257. ------------------------------------------------------------------------------------
  258.  
  259. RELEASECOPYOFSOCKET
  260. L
  261. <socket/N>
  262. Dup and release the copy of socket
  263.  
  264. ------------------------------------------------------------------------------------
  265.  
  266. RELEASESOCKET
  267. L
  268. <socket>
  269. Release a socket
  270.  
  271. ------------------------------------------------------------------------------------
  272.  
  273. RESOLVE
  274. D
  275. <host>
  276. Convert from string or name to Internet address
  277.  
  278. ------------------------------------------------------------------------------------
  279.  
  280. SEND
  281. LDd
  282. <socket/N>,<data>,[flags/N]
  283. Send data to a connected socket
  284.  
  285. ------------------------------------------------------------------------------------
  286.  
  287. SENDTO
  288. LDdv
  289. <socket/N>,<data>,<stem/V>,[flags/N]
  290. Send data to a socket
  291.  
  292. ------------------------------------------------------------------------------------
  293.  
  294. SETSOCKETBASE
  295. V
  296. <stem/V>
  297. Set various things in socket base
  298.  
  299. ------------------------------------------------------------------------------------
  300.  
  301. SETSOCKOPT
  302. LSSDll
  303. <socket/N>,<level>,<opt>,[value],[value/N]
  304. Set various things on socket at level level
  305.  
  306. ------------------------------------------------------------------------------------
  307.  
  308. SHUTDOWN
  309. LL
  310. <socket/N>,<mode/N>
  311. Close a socket and shutdown the connection
  312.  
  313. ------------------------------------------------------------------------------------
  314.  
  315. SYSLOG
  316. D
  317. <msg>
  318. Write a message to systemlog
  319.  
  320. ------------------------------------------------------------------------------------
  321.  
  322. SOCKET
  323. DDD
  324. <family>,<type>,<protocol>
  325. Create a socket
  326.  
  327. ------------------------------------------------------------------------------------
  328.  
  329. WAITSELECT
  330. Vlll
  331. <stem/V>,[secs/N],[micro/N],[signals/N]
  332. Wait for sockets events, timeout or exec signals
  333.  
  334. ------------------------------------------------------------------------------------
  335.  
  336. ALLOCSIGNAL
  337. -
  338. -
  339. Allocate an exec signal
  340.  
  341. ------------------------------------------------------------------------------------
  342.  
  343. FREESIGNAL
  344. L
  345. <signal/N>
  346. Free an allocated exec signal
  347.  
  348. ------------------------------------------------------------------------------------
  349.  
  350. OR
  351. LLlllllllllllll
  352. <signal/N>,<signal/N>,{signal/N}
  353. Or 2 to 14 number
  354.  
  355. ------------------------------------------------------------------------------------
  356.  
  357. AND
  358. LLlllllllllllll
  359. <signal/N>,<signal/N>,{signal/N}
  360. And 2 to 14 number
  361.  
  362. ------------------------------------------------------------------------------------
  363.  
  364. PORTSIGNAL
  365. D
  366. <portName>
  367. Return the signal of (in macro created) port
  368.  
  369. ------------------------------------------------------------------------------------
  370.  
  371. WAIT
  372. Lll
  373. <signals/N>,[sec/N],[micro/N]
  374. Wait for signals with, if present, a timeout of sec and micro
  375.  
  376. ------------------------------------------------------------------------------------
  377.  
  378. SIGNAL
  379. LL
  380. <task/N>,<signals/N>
  381. Signal an exec task
  382.  
  383. ------------------------------------------------------------------------------------
  384.  
  385.  
  386. 2.Human forms
  387.  
  388. - type as in socket(family,type,protocol)
  389.   the type of the socket has the string forms
  390.   "STREAM"
  391.   "DGRAM"
  392.   "RAW"
  393.   "RDM"
  394.   "SEQPACKET"
  395.  
  396.   can be passed as integer too.
  397.  
  398. - protocoll as in socket(family,type,protocol)
  399.   the protocol of the socket has the string forms
  400.   "IP"
  401.   "HOPOPTS"
  402.   "ICMP"
  403.   "IGMP"
  404.   "GGP"
  405.   "IPIP"
  406.   "TCP"
  407.   "EGP"
  408.   "PUP"
  409.   "UDP"
  410.   "IDP"
  411.   "TP"
  412.   "IPV6"
  413.   "ROUTING"
  414.   "FRAGMENT"
  415.   "RSVP"
  416.   "ESP"
  417.   "AH"
  418.   "ICMPV6"
  419.   "NONE"
  420.   "DSTOPTS"
  421.   "EON"
  422.   "ENCAP"
  423.   "DIVERT"
  424.   "RAW"
  425.  
  426. ------------------------------------------------------------------------------------
  427.  
  428. 3.Fields names
  429.  
  430.     For each structure the fields read or write by functions are:
  431.  
  432.      - hostent
  433.     - HOSTNAME
  434.     - HOSTADDRTYPE
  435.     - HOSTLENGTH
  436.     - HOSTALIASES.NUM
  437.     - HOSTALIASES.0 , ... , HOSTALIASES.last ( last = HOSTALIASES.NUM-1 )
  438.     - HOSTADDRLIST.NUM
  439.     - HOSTADDRLIST.0 , ... , HOSTADDRLIST.last ( last = HOSTADDRLIST.NUM-1 )
  440.  
  441.  
  442.     - servent
  443.     - SERVNAME
  444.     - SPORT
  445.     - SERVPROTO
  446.     - SERVALIASES.NUM
  447.     - SERVALIASES.0 , ... , SERVALIASES.last ( last = SERVALIASES.NUM-1 )
  448.  
  449.     - protoent
  450.     - PROTONAME
  451.     - PROTOPROTO
  452.     - PROTOALIASES.NUM
  453.     - PROTOALIASES.0 , ... , PROTOALIASES.last ( last = PROTOALIASES.NUM-1 )
  454.  
  455.     - struct sockaddr_in
  456.     passed as argument to functions
  457.     - ADDRFAMILY
  458.     - ADDRPORT
  459.     - ADDRADDR
  460.  
  461.     returned from functions
  462.     - ADDRLEN
  463.     - ADDRFAMILY
  464.     - ADDRPORT
  465.     - ADDRADDR
  466.  
  467.